FlowStarterPosition

Represents a workflow step for managing the starting position of a flow, with various timeout and notification options.

Properties

Name	Description
MessageOptions	Gets or sets the message options.
NotificationOptions	Gets or sets the push notification options.
Id	The unique identifier of the starter position.
Key	A unique identifier for the workflow step.
MailMessage	Gets the mail message associated with the message.
WorkflowCodeInstance	The workflow code instance associated with the flow object.
CachedDMObjects	The cached document management objects related to the flow object.
DoNotSendRequestIfProcessed	Indicates whether requests should be avoided if already processed.
NotificationCaption	Gets the notification caption associated with the message.
NotificationMessage	Gets the notification message associated with the message.
HideApporoverInHistory	Determines whether the approver should be hidden in the workflow history.
AutoOpenApprovalOption	Indicates if approval options should automatically open for this position.
IsCustomMailMessage	Gets or sets a value indicating whether the mail message is custom.
MailSubject	Gets the mail subject associated with the message.
GeolocationOptions	Geolocation options associated with the starter position.
EnableSendMail	Gets or sets a value indicating whether sending mail is enabled.
TypeCode	The type code associated with the flow object.
EventsToCheck	A list of events that need to be monitored for the starter position.
TimeoutHour	The number of hours specified for the timeout duration.
RequestIsNecessaryIfDocumentChanged	Specifies if a request is required when the associated document is modified.
TimeoutDuration	The total timeout duration represented as a TimeSpan.
Attachments	Gets the list of attachments associated with the message.
WebNotificationOptions	Gets or sets the web notification options.
Description	A description of the starter position, typically the full name of the user.
TimeoutOptions	Timeout options for managing delays and expiration settings for the starter position.
TimeoutDay	The number of days specified for the timeout duration.
Name	Name for the workflow step.
CalculateUsingWorkingHours	Determines if working hours should be used in timeout calculations.
Email	The email address of the user in the starter position.
Documents	A list of documents associated with the starter position.
Events	A read-only list of events linked to the starter position.
EnablePushNotification	Gets or sets a value indicating whether push notification is enabled.
CustomMailMessage	Gets the custom mail message associated with the message.
TimeoutMinute	The number of minutes specified for the timeout duration.
ShowInFlowHistory	Specifies if the position should appear in the workflow history.
CalculateUsingHolidays	Specifies if holidays should be considered in timeout calculations.
Caption	The caption dictionary representing localized captions for the flow object.
Code	The code or username associated with the starter position.

Constructors

Name	Description
FlowStarterPosition(name, workflowData, workflowCodeInstance)	Constructor for the FlowStarterPosition class. Initializes a new instance of the FlowStarterPosition class.
FlowStarterPosition(name,workflowData,workflowCodeInstance)	Initializes a new instance of the FlowStarterPosition class with a name, workflow data, and workflow code instance.
FlowStarterPosition(name,workflowData,workflowCodeInstance)	Initializes a new instance of the FlowStarterPosition class.

Methods

Name	Description
SendMail(requestItem)	Sends an email notification for the process request associated with the starter position.
Initialize()	Initializes the starter position with default settings.
AddAttachment(value,type)	Adds an attachment to the mail message.
GetStarterUserInfo()	Retrieves the user information for the starter position.
SendPushNotification(userInfo,requestItem)	Sends a push notification to a user.
ToLiquid()	Converts the starter position data into a format compatible with Liquid templates.
SendWebNotification(payloadType,userInfo,requestItem)	Sends a web notification to a user.

Events

Name	Description
OnBeforeExecution(sender, args)	Occurs before the execution of the workflow step.
OnAfterExecution(sender, args)	Occurs after the execution of the workflow step.

Generic Types

Name	Description
TProperties	Generic type of properties.